updating read.me and docs for template #5
Conversation
| @@ -1,3 +1 @@ | |||
| # API Reference | |||
|
|
|||
There was a problem hiding this comment.
Maybe it is obvious already so it is not needed but I originally left this to showcase the syntax
There was a problem hiding this comment.
when i left it, it caused an error when I ran mkdocs serve:
ERROR - Error reading page 'api.md': ERROR - Could not collect 'blueprint.hello'
i'll try re-add the example as a string to avoid the error
There was a problem hiding this comment.
ERROR - Error reading page 'api.md': ERROR - Could not collect 'blueprint.hello'
Right, I think it might be because the project itself was not installed.
You need to:
pip install -e .
From the root so mkdocs can import the blueprint module.
There was a problem hiding this comment.
There are some changes needed in order to make the workflows work on this repo, I will open a PR
There was a problem hiding this comment.
@daavoo - okay do you want me to hold-off merging this? or can i go ahead and then you will do another PR?
There was a problem hiding this comment.
Is ok to merge this, I will open a different PR
| @@ -1,3 +1 @@ | |||
| # API Reference | |||
|
|
|||
There was a problem hiding this comment.
Is ok to merge this, I will open a different PR
What's changing
Modified the template read.me to reflect latest approach. Added some generic pages to the Docs.
How to test it
Check docs run
mkdocs serveAdditional notes for reviewers
I already...
/docs)